<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>colorizer Docs</title>
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1>colorizer</h1>


<ul>
  <li><a href="../index.html">Index</a></li>
</ul>

<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
</ul>


<h2>Modules</h2>
<ul class="nowrap">
  <li><a href="../modules/colorizer.html">colorizer</a></li>
  <li><strong>buffer</strong></li>
  <li><a href="../modules/colorizer.color.html">color</a></li>
  <li><a href="../modules/colorizer.config.html">config</a></li>
  <li><a href="../modules/colorizer.constants.html">constants</a></li>
  <li><a href="../modules/colorizer.matcher.html">matcher</a></li>
  <li><a href="../modules/colorizer.parser.rgb_hex.html">parser.rgb_hex</a></li>
  <li><a href="../modules/colorizer.parser.hsl.html">parser.hsl</a></li>
  <li><a href="../modules/colorizer.parser.names.html">parser.names</a></li>
  <li><a href="../modules/colorizer.parser.oklch.html">parser.oklch</a></li>
  <li><a href="../modules/colorizer.parser.rgb.html">parser.rgb</a></li>
  <li><a href="../modules/colorizer.parser.rgba_hex.html">parser.rgba_hex</a></li>
  <li><a href="../modules/colorizer.parser.xterm.html">parser.xterm</a></li>
  <li><a href="../modules/colorizer.sass.html">sass</a></li>
  <li><a href="../modules/colorizer.tailwind.html">tailwind</a></li>
  <li><a href="../modules/trie.html">trie</a></li>
  <li><a href="../modules/colorizer.usercmds.html">usercmds</a></li>
  <li><a href="../modules/colorizer.utils.html">utils</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>colorizer.buffer</code></h1>
<p>Provides highlighting functions for buffer</p>
<p></p>


<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#reset_cache">reset_cache ()</a></td>
	<td class="summary">Clean the highlight cache</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#add_highlight">add_highlight (bufnr, ns_id, line_start, line_end, data, ud_opts, hl_opts)</a></td>
	<td class="summary">Create highlight and set highlights</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#highlight">highlight (bufnr, ns_id, line_start, line_end, ud_opts, buf_local_opts)</a></td>
	<td class="summary">Highlight the buffer region.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#parse_lines">parse_lines (bufnr, lines, line_start, ud_opts)</a></td>
	<td class="summary">Parse the given lines for colors and return a table containing
 rgb_hex and range per line</td>
	</tr>
</table>

<br/>
<br/>


    <h2 class="section-header "><a name="Functions"></a>Functions</h2>

    <dl class="function">
    <dt>
    <a name = "reset_cache"></a>
    <strong>reset_cache ()</strong>
    </dt>
    <dd>
    Clean the highlight cache







</dd>
    <dt>
    <a name = "add_highlight"></a>
    <strong>add_highlight (bufnr, ns_id, line_start, line_end, data, ud_opts, hl_opts)</strong>
    </dt>
    <dd>
    Create highlight and set highlights


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">bufnr</span>
         number: Buffer number (0 for current)
        </li>
        <li><span class="parameter">ns_id</span>
         number: Namespace id for which to create highlights
        </li>
        <li><span class="parameter">line_start</span>
         number: Line_start should be 0-indexed
        </li>
        <li><span class="parameter">line_end</span>
         number: Last line to highlight
        </li>
        <li><span class="parameter">data</span>
         table: Table output of `parse_lines`
        </li>
        <li><span class="parameter">ud_opts</span>
         table: `user_default_options`
        </li>
        <li><span class="parameter">hl_opts</span>
         table|nil: Highlight options:
 - tailwind_lsp boolean: Clear tailwind_names namespace when applying Tailwind LSP highlighting
        </li>
    </ul>





</dd>
    <dt>
    <a name = "highlight"></a>
    <strong>highlight (bufnr, ns_id, line_start, line_end, ud_opts, buf_local_opts)</strong>
    </dt>
    <dd>
    Highlight the buffer region.
 Highlight starting from `line_start` (0-indexed) for each line described by `lines` in the
 buffer id `bufnr` and attach it to the namespace id `ns_id`.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">bufnr</span>
         number: Buffer number, 0 for current
        </li>
        <li><span class="parameter">ns_id</span>
         number: Namespace id, default is "colorizer" created with vim.api.nvim_create_namespace
        </li>
        <li><span class="parameter">line_start</span>
         number: line_start should be 0-indexed
        </li>
        <li><span class="parameter">line_end</span>
         number: Last line to highlight
        </li>
        <li><span class="parameter">ud_opts</span>
         table: `user_default_options`
        </li>
        <li><span class="parameter">buf_local_opts</span>
         table: Buffer local options
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

         table: Detach settings table to use when cleaning up buffer state in `colorizer.detach_from_buffer`
 - ns_id number: Table of namespace ids to clear
 - functions function: Table of detach functions to call
    </ol>




</dd>
    <dt>
    <a name = "parse_lines"></a>
    <strong>parse_lines (bufnr, lines, line_start, ud_opts)</strong>
    </dt>
    <dd>
    Parse the given lines for colors and return a table containing
 rgb_hex and range per line


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">bufnr</span>
         number: Buffer number (0 for current)
        </li>
        <li><span class="parameter">lines</span>
         table: Table of lines to parse
        </li>
        <li><span class="parameter">line_start</span>
         number: Buffer line number to start highlighting
        </li>
        <li><span class="parameter">ud_opts</span>
         table: `user_default_options`
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

        table|nil
    </ol>




</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated - October </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
